GET api/runs?date={date}&serviceTypeId[0]={serviceTypeId[0]}&serviceTypeId[1]={serviceTypeId[1]}

Gets runs

Request Information

URI Parameters

Name	Description	Type	Additional information
date	The date to get runs for. Will also include the day before and the day after, for backwards compatibility reasons.	date	Required
serviceTypeId	The service type to use to filter the runs	Collection of integer	Required

Body Parameters

None.

Response Information

Resource Description

The runs matching the given serviceType and date

Collection of Run

Name	Description	Type	Additional information
Name	The name of the run	string	None.
Events	The events in the run	Collection of Event	None.
Vehicle	Information about the vehicle assigned to the run	RunVehicle	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "name": "sample string 1",
    "events": [
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1,
          "timeZoneId": "sample string 9"
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "serviceTypeId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2024-12-23T12:28:32.8383051-07:00",
        "actualArrive": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeEarly": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTime": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeLate": "2024-12-23T12:28:32.8383051-07:00"
      },
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1,
          "timeZoneId": "sample string 9"
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "serviceTypeId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2024-12-23T12:28:32.8383051-07:00",
        "actualArrive": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeEarly": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTime": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeLate": "2024-12-23T12:28:32.8383051-07:00"
      }
    ],
    "vehicle": {
      "vehicleId": 1,
      "gpsData": {
        "latitude": 1.1,
        "longitude": 2.1,
        "direction": 1.1,
        "gpsTime": "2024-12-23T12:28:32.8393059-07:00"
      },
      "vehicleNumber": "sample string 2",
      "description": "sample string 3",
      "year": 1,
      "make": "sample string 4",
      "model": "sample string 5",
      "licensePlate": "sample string 6"
    }
  },
  {
    "name": "sample string 1",
    "events": [
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1,
          "timeZoneId": "sample string 9"
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "serviceTypeId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2024-12-23T12:28:32.8383051-07:00",
        "actualArrive": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeEarly": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTime": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeLate": "2024-12-23T12:28:32.8383051-07:00"
      },
      {
        "location": {
          "name": "sample string 1",
          "streetNumber": "sample string 2",
          "onStreet": "sample string 3",
          "atStreet": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "postalCode": "sample string 7",
          "unit": "sample string 8",
          "latitude": 1.1,
          "longitude": 1.1,
          "timeZoneId": "sample string 9"
        },
        "driver": null,
        "clientId": 1,
        "bookingId": 1,
        "serviceTypeId": 1,
        "action": 0,
        "status": 1,
        "estimatedTime": "2024-12-23T12:28:32.8383051-07:00",
        "actualArrive": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeEarly": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTime": "2024-12-23T12:28:32.8383051-07:00",
        "scheduledTimeLate": "2024-12-23T12:28:32.8383051-07:00"
      }
    ],
    "vehicle": {
      "vehicleId": 1,
      "gpsData": {
        "latitude": 1.1,
        "longitude": 2.1,
        "direction": 1.1,
        "gpsTime": "2024-12-23T12:28:32.8393059-07:00"
      },
      "vehicleNumber": "sample string 2",
      "description": "sample string 3",
      "year": 1,
      "make": "sample string 4",
      "model": "sample string 5",
      "licensePlate": "sample string 6"
    }
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.